<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libcoap: str.c Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">libcoap<span id="projectnumber">&#160;4.2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('str_8c_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="headertitle"><div class="title">str.c</div></div>
</div><!--header-->
<div class="contents">
<a href="str_8c.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* str.c -- strings to be used in the CoAP library</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> *</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> * Copyright (C) 2010,2011 Olaf Bergmann &lt;bergmann@tzi.org&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * This file is part of the CoAP library libcoap. Please see</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * README for terms of use.</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> */</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="preprocessor">#include &quot;coap_config.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="preprocessor">#include &lt;stdio.h&gt;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="preprocessor">#include &quot;<a class="code" href="libcoap_8h.html">libcoap.h</a>&quot;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="preprocessor">#include &quot;<a class="code" href="coap__debug_8h.html">coap_debug.h</a>&quot;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="preprocessor">#include &quot;<a class="code" href="mem_8h.html">mem.h</a>&quot;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="preprocessor">#include &quot;<a class="code" href="str_8h.html">str.h</a>&quot;</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span> </div>
<div class="foldopen" id="foldopen00018" data-start="{" data-end="}">
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="group__string.html#ga9862b1ade5e6e2eb01aabd0fa98b63e1">   18</a></span><a class="code hl_struct" href="structcoap__string__t.html">coap_string_t</a> *<a class="code hl_function" href="group__string.html#ga9862b1ade5e6e2eb01aabd0fa98b63e1">coap_new_string</a>(<span class="keywordtype">size_t</span> size) {</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span>  <a class="code hl_struct" href="structcoap__string__t.html">coap_string_t</a> *s =</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span>            (<a class="code hl_struct" href="structcoap__string__t.html">coap_string_t</a> *)<a class="code hl_function" href="mem_8h.html#a9f9fd8d6cf24f9c45a5501aeba5acaf9">coap_malloc_type</a>(<a class="code hl_enumvalue" href="mem_8h.html#a703fa791ab7a14ff983df73b15e9c620ac4b8bae3a94d882154fabe0957a3ab2e">COAP_STRING</a>, <span class="keyword">sizeof</span>(<a class="code hl_struct" href="structcoap__string__t.html">coap_string_t</a>) + size + 1);</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span>  <span class="keywordflow">if</span> ( !s ) {</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#ifndef NDEBUG</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span>    <a class="code hl_define" href="group__logging.html#gaff2785484e756c8ec2fce408f9b81f0f">coap_log</a>(<a class="code hl_enumvalue" href="group__logging.html#gga53c7b97a7af4d62d8c1678d658cc7446a3537fbf756308b6267dd4354615eb413">LOG_CRIT</a>, <span class="stringliteral">&quot;coap_new_string: malloc\n&quot;</span>);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span>    <span class="keywordflow">return</span> NULL;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span>  }</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>  memset(s, 0, <span class="keyword">sizeof</span>(<a class="code hl_struct" href="structcoap__string__t.html">coap_string_t</a>));</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>  s-&gt;<a class="code hl_variable" href="structcoap__string__t.html#ad904e545a40c835079a1eb2dd230fb29">s</a> = ((<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *)s) + <span class="keyword">sizeof</span>(<a class="code hl_struct" href="structcoap__string__t.html">coap_string_t</a>);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>  s-&gt;<a class="code hl_variable" href="structcoap__string__t.html#ad904e545a40c835079a1eb2dd230fb29">s</a>[size] = <span class="charliteral">&#39;\000&#39;</span>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>  <span class="keywordflow">return</span> s;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>}</div>
</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span> </div>
<div class="foldopen" id="foldopen00034" data-start="{" data-end="}">
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="group__string.html#gad991c87cfcf9b2414d2dc430c8701ed3">   34</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__string.html#gad991c87cfcf9b2414d2dc430c8701ed3">coap_delete_string</a>(<a class="code hl_struct" href="structcoap__string__t.html">coap_string_t</a> *s) {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>  <a class="code hl_function" href="mem_8h.html#ae7214e0c73a4d4290525873e739ed422">coap_free_type</a>(<a class="code hl_enumvalue" href="mem_8h.html#a703fa791ab7a14ff983df73b15e9c620ac4b8bae3a94d882154fabe0957a3ab2e">COAP_STRING</a>, s);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>}</div>
</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span> </div>
<div class="foldopen" id="foldopen00038" data-start="{" data-end="}">
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="group__string.html#gaac769e3d5cea5481436c9eb3cb28d92a">   38</a></span><a class="code hl_struct" href="structcoap__str__const__t.html">coap_str_const_t</a> *<a class="code hl_function" href="group__string.html#gaac769e3d5cea5481436c9eb3cb28d92a">coap_new_str_const</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="uthash_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *data, <span class="keywordtype">size_t</span> size) {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>  <a class="code hl_struct" href="structcoap__string__t.html">coap_string_t</a> *s = <a class="code hl_function" href="group__string.html#ga9862b1ade5e6e2eb01aabd0fa98b63e1">coap_new_string</a>(size);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>  <span class="keywordflow">if</span> (!s)</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>    <span class="keywordflow">return</span> NULL;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>  memcpy (s-&gt;<a class="code hl_variable" href="structcoap__string__t.html#ad904e545a40c835079a1eb2dd230fb29">s</a>, data, size);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>  s-&gt;<a class="code hl_variable" href="structcoap__string__t.html#adbca4bb782ba6046520f8608ef0f5a66">length</a> = size;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>  <span class="keywordflow">return</span> (<a class="code hl_struct" href="structcoap__str__const__t.html">coap_str_const_t</a> *)s;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>}</div>
</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span> </div>
<div class="foldopen" id="foldopen00047" data-start="{" data-end="}">
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="group__string.html#ga4c283744d0fa51b553bf3fc52488e4b0">   47</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__string.html#ga4c283744d0fa51b553bf3fc52488e4b0">coap_delete_str_const</a>(<a class="code hl_struct" href="structcoap__str__const__t.html">coap_str_const_t</a> *s) {</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>  <a class="code hl_function" href="mem_8h.html#ae7214e0c73a4d4290525873e739ed422">coap_free_type</a>(<a class="code hl_enumvalue" href="mem_8h.html#a703fa791ab7a14ff983df73b15e9c620ac4b8bae3a94d882154fabe0957a3ab2e">COAP_STRING</a>, s);</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>}</div>
</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span> </div>
<div class="ttc" id="acoap__debug_8h_html"><div class="ttname"><a href="coap__debug_8h.html">coap_debug.h</a></div></div>
<div class="ttc" id="agroup__logging_html_gaff2785484e756c8ec2fce408f9b81f0f"><div class="ttname"><a href="group__logging.html#gaff2785484e756c8ec2fce408f9b81f0f">coap_log</a></div><div class="ttdeci">#define coap_log(level,...)</div><div class="ttdoc">Logging function.</div><div class="ttdef"><b>Definition</b> <a href="coap__debug_8h_source.html#l00122">coap_debug.h:122</a></div></div>
<div class="ttc" id="agroup__logging_html_gga53c7b97a7af4d62d8c1678d658cc7446a3537fbf756308b6267dd4354615eb413"><div class="ttname"><a href="group__logging.html#gga53c7b97a7af4d62d8c1678d658cc7446a3537fbf756308b6267dd4354615eb413">LOG_CRIT</a></div><div class="ttdeci">@ LOG_CRIT</div><div class="ttdoc">Critical.</div><div class="ttdef"><b>Definition</b> <a href="coap__debug_8h_source.html#l00044">coap_debug.h:44</a></div></div>
<div class="ttc" id="agroup__string_html_ga4c283744d0fa51b553bf3fc52488e4b0"><div class="ttname"><a href="group__string.html#ga4c283744d0fa51b553bf3fc52488e4b0">coap_delete_str_const</a></div><div class="ttdeci">void coap_delete_str_const(coap_str_const_t *s)</div><div class="ttdoc">Deletes the given const string and releases any memory allocated.</div><div class="ttdef"><b>Definition</b> <a href="str_8c_source.html#l00047">str.c:47</a></div></div>
<div class="ttc" id="agroup__string_html_ga9862b1ade5e6e2eb01aabd0fa98b63e1"><div class="ttname"><a href="group__string.html#ga9862b1ade5e6e2eb01aabd0fa98b63e1">coap_new_string</a></div><div class="ttdeci">coap_string_t * coap_new_string(size_t size)</div><div class="ttdoc">Returns a new string object with at least size+1 bytes storage allocated.</div><div class="ttdef"><b>Definition</b> <a href="str_8c_source.html#l00018">str.c:18</a></div></div>
<div class="ttc" id="agroup__string_html_gaac769e3d5cea5481436c9eb3cb28d92a"><div class="ttname"><a href="group__string.html#gaac769e3d5cea5481436c9eb3cb28d92a">coap_new_str_const</a></div><div class="ttdeci">coap_str_const_t * coap_new_str_const(const uint8_t *data, size_t size)</div><div class="ttdoc">Returns a new const string object with at least size+1 bytes storage allocated, and the provided data...</div><div class="ttdef"><b>Definition</b> <a href="str_8c_source.html#l00038">str.c:38</a></div></div>
<div class="ttc" id="agroup__string_html_gad991c87cfcf9b2414d2dc430c8701ed3"><div class="ttname"><a href="group__string.html#gad991c87cfcf9b2414d2dc430c8701ed3">coap_delete_string</a></div><div class="ttdeci">void coap_delete_string(coap_string_t *s)</div><div class="ttdoc">Deletes the given string and releases any memory allocated.</div><div class="ttdef"><b>Definition</b> <a href="str_8c_source.html#l00034">str.c:34</a></div></div>
<div class="ttc" id="alibcoap_8h_html"><div class="ttname"><a href="libcoap_8h.html">libcoap.h</a></div></div>
<div class="ttc" id="amem_8h_html"><div class="ttname"><a href="mem_8h.html">mem.h</a></div></div>
<div class="ttc" id="amem_8h_html_a703fa791ab7a14ff983df73b15e9c620ac4b8bae3a94d882154fabe0957a3ab2e"><div class="ttname"><a href="mem_8h.html#a703fa791ab7a14ff983df73b15e9c620ac4b8bae3a94d882154fabe0957a3ab2e">COAP_STRING</a></div><div class="ttdeci">@ COAP_STRING</div><div class="ttdef"><b>Definition</b> <a href="mem_8h_source.html#l00030">mem.h:30</a></div></div>
<div class="ttc" id="amem_8h_html_a9f9fd8d6cf24f9c45a5501aeba5acaf9"><div class="ttname"><a href="mem_8h.html#a9f9fd8d6cf24f9c45a5501aeba5acaf9">coap_malloc_type</a></div><div class="ttdeci">void * coap_malloc_type(coap_memory_tag_t type, size_t size)</div><div class="ttdoc">Allocates a chunk of size bytes and returns a pointer to the newly allocated memory.</div></div>
<div class="ttc" id="amem_8h_html_ae7214e0c73a4d4290525873e739ed422"><div class="ttname"><a href="mem_8h.html#ae7214e0c73a4d4290525873e739ed422">coap_free_type</a></div><div class="ttdeci">void coap_free_type(coap_memory_tag_t type, void *p)</div><div class="ttdoc">Releases the memory that was allocated by coap_malloc_type().</div></div>
<div class="ttc" id="astr_8h_html"><div class="ttname"><a href="str_8h.html">str.h</a></div></div>
<div class="ttc" id="astructcoap__str__const__t_html"><div class="ttname"><a href="structcoap__str__const__t.html">coap_str_const_t</a></div><div class="ttdoc">Coap string data definition with const data.</div><div class="ttdef"><b>Definition</b> <a href="str_8h_source.html#l00033">str.h:33</a></div></div>
<div class="ttc" id="astructcoap__string__t_html"><div class="ttname"><a href="structcoap__string__t.html">coap_string_t</a></div><div class="ttdoc">Coap string data definition.</div><div class="ttdef"><b>Definition</b> <a href="str_8h_source.html#l00025">str.h:25</a></div></div>
<div class="ttc" id="astructcoap__string__t_html_ad904e545a40c835079a1eb2dd230fb29"><div class="ttname"><a href="structcoap__string__t.html#ad904e545a40c835079a1eb2dd230fb29">coap_string_t::s</a></div><div class="ttdeci">uint8_t * s</div><div class="ttdoc">string data</div><div class="ttdef"><b>Definition</b> <a href="str_8h_source.html#l00027">str.h:27</a></div></div>
<div class="ttc" id="astructcoap__string__t_html_adbca4bb782ba6046520f8608ef0f5a66"><div class="ttname"><a href="structcoap__string__t.html#adbca4bb782ba6046520f8608ef0f5a66">coap_string_t::length</a></div><div class="ttdeci">size_t length</div><div class="ttdoc">length of string</div><div class="ttdef"><b>Definition</b> <a href="str_8h_source.html#l00026">str.h:26</a></div></div>
<div class="ttc" id="authash_8h_html_aba7bc1797add20fe3efdf37ced1182c5"><div class="ttname"><a href="uthash_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a></div><div class="ttdeci">unsigned char uint8_t</div><div class="ttdef"><b>Definition</b> <a href="uthash_8h_source.html#l00079">uthash.h:79</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="str_8c.html">str.c</a></li>
    <li class="footer">Generated on Fri Dec 27 2024 09:57:44 for libcoap by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
  </ul>
</div>
</body>
</html>
